## API Report File for "@backstage/plugin-search-backend-module-techdocs"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts
/// <reference types="node" />

import { CatalogApi } from '@backstage/catalog-client';
import { Config } from '@backstage/config';
import { DocumentCollatorFactory } from '@backstage/plugin-search-common';
import { Entity } from '@backstage/catalog-model';
import { Logger } from 'winston';
import { Permission } from '@backstage/plugin-permission-common';
import { PluginEndpointDiscovery } from '@backstage/backend-common';
import { Readable } from 'stream';
import { TechDocsDocument } from '@backstage/plugin-techdocs-node';
import { TokenManager } from '@backstage/backend-common';

// @public (undocumented)
export const defaultTechDocsCollatorEntityTransformer: TechDocsCollatorEntityTransformer;

// @public
export class DefaultTechDocsCollatorFactory implements DocumentCollatorFactory {
  // (undocumented)
  static fromConfig(
    config: Config,
    options: TechDocsCollatorFactoryOptions,
  ): DefaultTechDocsCollatorFactory;
  // (undocumented)
  getCollator(): Promise<Readable>;
  // (undocumented)
  readonly type: string;
  // (undocumented)
  readonly visibilityPermission: Permission;
}

// @public (undocumented)
export type TechDocsCollatorEntityTransformer = (
  entity: Entity,
) => Omit<TechDocsDocument, 'location' | 'authorization'>;

// @public
export type TechDocsCollatorFactoryOptions = {
  discovery: PluginEndpointDiscovery;
  logger: Logger;
  tokenManager: TokenManager;
  locationTemplate?: string;
  catalogClient?: CatalogApi;
  parallelismLimit?: number;
  legacyPathCasing?: boolean;
  entityTransformer?: TechDocsCollatorEntityTransformer;
};
```
